﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class FloatingNodeRuleViolation
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class FloatingNodeRuleViolation
   ">
    <meta name="generator" content="docfx 2.52.0.0">
    
    <link rel="shortcut icon" href="../api/images/favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    <script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script>
    
    
    
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../api/images/favicon.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation">
  
  
  <h1 id="SpiceSharp_Validation_FloatingNodeRuleViolation" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation" class="text-break">Class FloatingNodeRuleViolation
  </h1>
  <div class="markdown level0 summary"><p>An <a class="xref" href="SpiceSharp.Validation.IRuleViolation.html">IRuleViolation</a> for a <a class="xref" href="SpiceSharp.Validation.FloatingNodeRule.html">FloatingNodeRule</a>.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">FloatingNodeRuleViolation</span></div>
  </div>
  <div classs="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="SpiceSharp.Validation.IRuleViolation.html">IRuleViolation</a></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <span class="xref">System.Object.ToString()</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.GetHashCode()</span>
    </div>
    <div>
      <span class="xref">System.Object.GetType()</span>
    </div>
    <div>
      <span class="xref">System.Object.MemberwiseClone()</span>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="SpiceSharp.Validation.html">SpiceSharp.Validation</a></h6>
  <h6><strong>Assembly</strong>: SpiceSharp.dll</h6>
  <h5 id="SpiceSharp_Validation_FloatingNodeRuleViolation_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class FloatingNodeRuleViolation : IRuleViolation</code></pre>
  </div>
  <h3 id="constructors">Constructors
  </h3>
  <a id="SpiceSharp_Validation_FloatingNodeRuleViolation__ctor_" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.#ctor*"></a>
  <h4 id="SpiceSharp_Validation_FloatingNodeRuleViolation__ctor_SpiceSharp_Validation_IRule_SpiceSharp_Simulations_IVariable_SpiceSharp_Simulations_IVariable_SpiceSharp_Validation_ConductionTypes_" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.#ctor(SpiceSharp.Validation.IRule,SpiceSharp.Simulations.IVariable,SpiceSharp.Simulations.IVariable,SpiceSharp.Validation.ConductionTypes)">FloatingNodeRuleViolation(IRule, IVariable, IVariable, ConductionTypes)</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="SpiceSharp.Validation.FloatingNodeRuleViolation.html">FloatingNodeRuleViolation</a> class.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public FloatingNodeRuleViolation(IRule rule, IVariable floatingVariable, IVariable fixedVariable, ConductionTypes type)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Validation.IRule.html">IRule</a></td>
        <td><span class="parametername">rule</span></td>
        <td><p>The rule.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.IVariable.html">IVariable</a></td>
        <td><span class="parametername">floatingVariable</span></td>
        <td><p>The floating node variable.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.IVariable.html">IVariable</a></td>
        <td><span class="parametername">fixedVariable</span></td>
        <td><p>The fixed node variable.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="SpiceSharp.Validation.ConductionTypes.html">ConductionTypes</a></td>
        <td><span class="parametername">type</span></td>
        <td><p>The path type.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
  </h3>
  <a id="SpiceSharp_Validation_FloatingNodeRuleViolation_FixedVariable_" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.FixedVariable*"></a>
  <h4 id="SpiceSharp_Validation_FloatingNodeRuleViolation_FixedVariable" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.FixedVariable">FixedVariable</h4>
  <div class="markdown level1 summary"><p>Gets the fixed node variable.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IVariable FixedVariable { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.IVariable.html">IVariable</a></td>
        <td><p>The fixed node variable.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Validation_FloatingNodeRuleViolation_FloatingVariable_" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.FloatingVariable*"></a>
  <h4 id="SpiceSharp_Validation_FloatingNodeRuleViolation_FloatingVariable" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.FloatingVariable">FloatingVariable</h4>
  <div class="markdown level1 summary"><p>Gets the floating node variable.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IVariable FloatingVariable { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.IVariable.html">IVariable</a></td>
        <td><p>The floating node variable.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Validation_FloatingNodeRuleViolation_Rule_" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.Rule*"></a>
  <h4 id="SpiceSharp_Validation_FloatingNodeRuleViolation_Rule" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.Rule">Rule</h4>
  <div class="markdown level1 summary"><p>Gets the rule that was violated.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IRule Rule { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Validation.IRule.html">IRule</a></td>
        <td><p>The violated rule.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Validation_FloatingNodeRuleViolation_Subject_" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.Subject*"></a>
  <h4 id="SpiceSharp_Validation_FloatingNodeRuleViolation_Subject" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.Subject">Subject</h4>
  <div class="markdown level1 summary"><p>Gets the subject that caused the rule violation (if any).</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IRuleSubject Subject { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Validation.IRuleSubject.html">IRuleSubject</a></td>
        <td><p>The subject that caused the violation.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Validation_FloatingNodeRuleViolation_Type_" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.Type*"></a>
  <h4 id="SpiceSharp_Validation_FloatingNodeRuleViolation_Type" data-uid="SpiceSharp.Validation.FloatingNodeRuleViolation.Type">Type</h4>
  <div class="markdown level1 summary"><p>Gets the type of connection to the fixed variable.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public ConductionTypes Type { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Validation.ConductionTypes.html">ConductionTypes</a></td>
        <td><p>The type.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="implements">Implements</h3>
  <div>
      <a class="xref" href="SpiceSharp.Validation.IRuleViolation.html">IRuleViolation</a>
  </div>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="SpiceSharp.Utility.html#SpiceSharp_Utility_ThrowIfNull__1___0_System_String_">Utility.ThrowIfNull&lt;T&gt;(T, String)</a>
  </div>
  <h3 id="seealso">See Also</h3>
  <div class="seealso">
      <div><a class="xref" href="SpiceSharp.Validation.IRuleViolation.html">IRuleViolation</a></div>
  </div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
